Package org.dogtagpki.server.rest.v1

Class ApiDeprecationFilter

java.lang.Object

org.dogtagpki.server.rest.v1.ApiDeprecationFilter

All Implemented Interfaces:

jakarta.ws.rs.container.ContainerResponseFilter

@Provider
public class ApiDeprecationFilter
extends Object
implements jakarta.ws.rs.container.ContainerResponseFilter

JAX-RS response filter that adds standard deprecation headers to all v1 API responses when the API status is set to "deprecated". Implements: - Deprecation header (IETF draft-dalal-deprecation-header) - Link header pointing to v2 API documentation (RFC 8288)

Constructor Summary

Constructors

Constructor	Description
ApiDeprecationFilter()

Method Summary

Modifier and Type	Method	Description
void	filter(jakarta.ws.rs.container.ContainerRequestContext requestContext, jakarta.ws.rs.container.ContainerResponseContext responseContext)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ApiDeprecationFilter

public ApiDeprecationFilter()

Method Details

filter

public void filter(jakarta.ws.rs.container.ContainerRequestContext requestContext,
 jakarta.ws.rs.container.ContainerResponseContext responseContext)
            throws IOException

Specified by:

filter in interface jakarta.ws.rs.container.ContainerResponseFilter

Throws:

IOException